Skip to content

Comments

docs: add Lua authoring guide and reorganize docs folder#4

Merged
amirna2 merged 1 commit intomainfrom
docs/lua-authoring-guide
Feb 23, 2026
Merged

docs: add Lua authoring guide and reorganize docs folder#4
amirna2 merged 1 commit intomainfrom
docs/lua-authoring-guide

Conversation

@amirna2
Copy link
Owner

@amirna2 amirna2 commented Feb 23, 2026

Summary

Add a comprehensive Lua authoring guide (docs/lua-authoring-guide.md) — the complete reference for game creators. Covers constructors, rules, conditions, effects, templates, dialogue, built-in verbs, common patterns, and validation errors. Also reorganizes docs/ by moving design documents into docs/design/, adds development invariants to CLAUDE.md, and adds ideas tracking.

Purpose

There was no documentation for someone wanting to write a game in QuestCore. Authors would have to reverse-engineer loader/api.go and the Lost Crown source. This guide makes QuestCore usable by anyone beyond the core developers.

Related plan: docs/plans/game-creator-guide.md

Tests Performed

  • All Lua function signatures verified against loader/api.go
  • All effect types verified against engine/effects/effects.go
  • All template variables verified against engine/effects/effects.go interpolation
  • All verb aliases verified against engine/parser/parser.go
  • All validation errors verified against loader/validate.go
  • Quick Start example verified as a valid game structure that would load and run

Tests Not Performed

  • No automated tests — this is a documentation-only change
  • make ci not run (no code changes)

CI Checks

  • make ci passes locally

AI Assisted

  • Yes
  • No

🤖 Generated with Claude Code

Add a comprehensive Lua authoring guide (docs/lua-authoring-guide.md) covering
the full API surface for game creators: constructors, rules, conditions, effects,
templates, dialogue, built-in verbs, patterns, and validation errors. All content
verified against source code.

Also reorganizes docs/ by moving design documents into docs/design/, adds
development invariants to CLAUDE.md, and adds ideas tracking.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@amirna2 amirna2 merged commit c17dc55 into main Feb 23, 2026
2 checks passed
@amirna2 amirna2 deleted the docs/lua-authoring-guide branch February 23, 2026 07:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant